home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / stdlib / RCS / strtol.man,v < prev    next >
Encoding:
Text File  |  1989-01-06  |  3.0 KB  |  95 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     89.01.05.17.59.48;  author ouster;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @@
  17.  
  18.  
  19.  
  20. 1.1
  21. log
  22. @Initial revision
  23. @
  24. text
  25. @' Copyright 1989 Regents of the University of California
  26. ' Permission to use, copy, modify, and distribute this
  27. ' documentation for any purpose and without fee is hereby
  28. ' granted, provided that this notice appears in all copies.
  29. ' The University of California makes no representations about
  30. ' the suitability of this material for any purpose.  It is
  31. ' provided "as is" without express or implied warranty.
  32. ' 
  33. ' $Header: /sprite/lib/forms/RCS/proto.man,v 1.1 88/12/29 17:09:50 ouster Exp $ SPRITE (Berkeley)
  34. ' 
  35. .so \*(]ltmac.sprite
  36. .HS strtol cmds
  37. .BS
  38. .SH NAME
  39. strtol, strtoul \- Convert character string to integer
  40. .SH SYNOPSIS
  41. .nf
  42. \fB#include <stdlib.h>
  43.  
  44. \fBlong int
  45. \fBstrtol(\fIstring\fR, \fIendPtr\fR, \fIbase\fR)
  46.  
  47. \fBunsigned long int
  48. \fBstrtoul(\fIstring\fR, \fIendPtr\fR, \fIbase\fR)
  49. .SH ARGUMENTS
  50. .AS "char *" endPtr
  51. .AP char *string in
  52. String containing ASCII representation of integer.
  53. .AP char **endPtr out
  54. If not \fBNULL\fR, gives address of pointer to fill in with address of
  55. first character in \fIstring\fR following integer.
  56. .AP int base in
  57. Base to use for conversion;  see below for explanation.  Must be
  58. between 0 and 36, inclusive.
  59. .BE
  60.  
  61. .SH DESCRIPTION
  62. .PP
  63. The \fBstrtol\fR and \fBstrtoul\fR procedures convert a character
  64. string to its corresponding integer representation and return the
  65. integer value.  Both procedures
  66. expect \fIstring\fR to point to a sequence of digits, optionally preceded
  67. by any amount of white space (as defined by the \fBisspace\fR procedure).
  68. \fBStrtol\fR also permits the digits to be preceded immediately by a
  69. minus sign, in which case the result is a negative integer.
  70. .PP
  71. If \fIbase\fR is between 2 and 36, inclusive, then the permissible
  72. ``digits'' of the string consist of the first \fIbase\fR characters
  73. in the set \fB0\fR through \fB9\fR and \fBa\fR through \fBz\fR
  74. (or \fBA\fR through \fBZ\fR).  The integer result will be calculated
  75. using \fIbase\fR as the radix for conversion.  If the value of \fIbase\fR
  76. is 16, then the characters \fB0x\fR or \fB0X\fR may precede the digits,
  77. following the sign if it is present.
  78. .PP
  79. If \fIbase\fR is 0, then the radix for conversion is chosen based on
  80. the initial digits of the number.  If the initial digits are \fB0x\fR
  81. or \fB0X\fR, then base 16 will be used for conversion;  otherwise if
  82. the first digit is \fB0\fR then base 8 will be used for conversion;
  83. otherwise base 10 will be used.
  84. .PP
  85. \fBStrtol\fR and \fBstrtoul\fR convert as many characters as possible
  86. from \fIstring\fR, and return in \fI*endPtr\fR the address of the first
  87. character not forming a valid portion of the number.  If no conversion
  88. could be performed (\fIstring\fR was empty, or did not point to a
  89. number in the expected form), then \fIstring\fR will be stored in
  90. \fI*endPtr\fR and zero is returned.
  91.  
  92. .SH KEYWORDS
  93. base, convert, integer, radix, string
  94. @
  95.